/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.ranger.view;

/**
 * Response
 */

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import org.apache.ranger.common.AppConstants;
import org.apache.ranger.common.view.ViewBaseBean;

import java.util.List;

@JsonAutoDetect(getterVisibility = Visibility.NONE, setterVisibility = Visibility.NONE, fieldVisibility = Visibility.ANY)
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
public class VXResponse extends ViewBaseBean implements java.io.Serializable {
    /**
     * STATUS_SUCCESS is an element of enum ResponseStatus. Its value is "STATUS_SUCCESS".
     */
    public static final int STATUS_SUCCESS         = 0;

    /**
     * Enum values for ResponseStatus
     */
    /**
     * STATUS_ERROR is an element of enum ResponseStatus. Its value is "STATUS_ERROR".
     */
    public static final int STATUS_ERROR           = 1;
    /**
     * STATUS_VALIDATION is an element of enum ResponseStatus. Its value is "STATUS_VALIDATION".
     */
    public static final int STATUS_VALIDATION      = 2;
    /**
     * STATUS_WARN is an element of enum ResponseStatus. Its value is "STATUS_WARN".
     */
    public static final int STATUS_WARN            = 3;
    /**
     * STATUS_INFO is an element of enum ResponseStatus. Its value is "STATUS_INFO".
     */
    public static final int STATUS_INFO            = 4;
    /**
     * STATUS_PARTIAL_SUCCESS is an element of enum ResponseStatus. Its value is "STATUS_PARTIAL_SUCCESS".
     */
    public static final int STATUS_PARTIAL_SUCCESS = 5;
    /**
     * Max value for enum ResponseStatus_MAX
     */
    public static final int ResponseStatus_MAX = 5;
    private static final long serialVersionUID = 1L;
    /**
     * Status code
     * This attribute is of type enum XResponse::ResponseStatus
     */
    protected int             statusCode;
    /**
     * Message description
     */
    protected String          msgDesc;
    /**
     * List of messages
     */
    protected List<VXMessage> messageList;

    /**
     * Default constructor. This will set all the attributes to default value.
     */
    public VXResponse() {
        statusCode = 0;
    }

    /**
     * Returns the value for the member attribute <b>statusCode</b>
     * @return int - value of member attribute <b>statusCode</b>.
     */
    public int getStatusCode() {
        return this.statusCode;
    }

    /**
     * This method sets the value to the member attribute <b>statusCode</b>.
     * You cannot set null to the attribute.
     * @param statusCode Value to set member attribute <b>statusCode</b>
     */
    public void setStatusCode(int statusCode) {
        this.statusCode = statusCode;
    }

    /**
     * Returns the value for the member attribute <b>msgDesc</b>
     * @return String - value of member attribute <b>msgDesc</b>.
     */
    public String getMsgDesc() {
        return this.msgDesc;
    }

    /**
     * This method sets the value to the member attribute <b>msgDesc</b>.
     * You cannot set null to the attribute.
     * @param msgDesc Value to set member attribute <b>msgDesc</b>
     */
    public void setMsgDesc(String msgDesc) {
        this.msgDesc = msgDesc;
    }

    /**
     * Returns the value for the member attribute <b>messageList</b>
     * @return List<VXMessage> - value of member attribute <b>messageList</b>.
     */
    public List<VXMessage> getMessageList() {
        return this.messageList;
    }

    /**
     * This method sets the value to the member attribute <b>messageList</b>.
     * You cannot set null to the attribute.
     * @param messageList Value to set member attribute <b>messageList</b>
     */
    public void setMessageList(List<VXMessage> messageList) {
        this.messageList = messageList;
    }

    @Override
    public int getMyClassType() {
        return AppConstants.CLASS_TYPE_RESPONSE;
    }

    /**
     * This return the bean content in string format
     * @return formatedStr
     */
    public String toString() {
        String str = "VXResponse={";
        str += super.toString();
        str += "statusCode={" + statusCode + "} ";
        str += "msgDesc={" + msgDesc + "} ";
        str += "messageList={" + messageList + "} ";
        str += "}";
        return str;
    }
}
